<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Alarm</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__rtc__alarm__functions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Alarm<div class="ingroups"><a class="el" href="group__group__rtc.html">RTC          (Real-Time Clock)</a> &raquo; <a class="el" href="group__group__rtc__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga92807dc709c679c70c07d44cf0331a94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__rtc__enums.html#ga45a1b113f07f81bc369d7bf9da75eaae">cy_en_rtc_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__rtc__alarm__functions.html#ga92807dc709c679c70c07d44cf0331a94">Cy_RTC_SetAlarmDateAndTime</a> (<a class="el" href="structcy__stc__rtc__alarm__t.html">cy_stc_rtc_alarm_t</a> const *alarmDateTime, <a class="el" href="group__group__rtc__enums.html#gad3785b5ad8bf1b0d49cc5f639176db5f">cy_en_rtc_alarm_t</a> alarmIndex)</td></tr>
<tr class="memdesc:ga92807dc709c679c70c07d44cf0331a94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets alarm time and date values into the ALMx_TIME and ALMx_DATE registers.  <a href="#ga92807dc709c679c70c07d44cf0331a94">More...</a><br /></td></tr>
<tr class="separator:ga92807dc709c679c70c07d44cf0331a94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d29c0bfa51f4afd969d448d13f502bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__rtc__alarm__functions.html#ga5d29c0bfa51f4afd969d448d13f502bd">Cy_RTC_GetAlarmDateAndTime</a> (<a class="el" href="structcy__stc__rtc__alarm__t.html">cy_stc_rtc_alarm_t</a> *alarmDateTime, <a class="el" href="group__group__rtc__enums.html#gad3785b5ad8bf1b0d49cc5f639176db5f">cy_en_rtc_alarm_t</a> alarmIndex)</td></tr>
<tr class="memdesc:ga5d29c0bfa51f4afd969d448d13f502bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current alarm time and date values from the ALMx_TIME and ALMx_DATE registers.  <a href="#ga5d29c0bfa51f4afd969d448d13f502bd">More...</a><br /></td></tr>
<tr class="separator:ga5d29c0bfa51f4afd969d448d13f502bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga67d28741bf5b0bee6be7b2e4ce45ef77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__rtc__enums.html#ga45a1b113f07f81bc369d7bf9da75eaae">cy_en_rtc_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__rtc__alarm__functions.html#ga67d28741bf5b0bee6be7b2e4ce45ef77">Cy_RTC_SetAlarmDateAndTimeDirect</a> (uint32_t sec, uint32_t min, uint32_t hour, uint32_t date, uint32_t month, <a class="el" href="group__group__rtc__enums.html#gad3785b5ad8bf1b0d49cc5f639176db5f">cy_en_rtc_alarm_t</a> alarmIndex)</td></tr>
<tr class="memdesc:ga67d28741bf5b0bee6be7b2e4ce45ef77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets alarm time and date values into the ALMx_TIME and ALMx_DATE registers using direct time parameters.  <a href="#ga67d28741bf5b0bee6be7b2e4ce45ef77">More...</a><br /></td></tr>
<tr class="separator:ga67d28741bf5b0bee6be7b2e4ce45ef77"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga92807dc709c679c70c07d44cf0331a94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga92807dc709c679c70c07d44cf0331a94">&#9670;&nbsp;</a></span>Cy_RTC_SetAlarmDateAndTime()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__rtc__enums.html#ga45a1b113f07f81bc369d7bf9da75eaae">cy_en_rtc_status_t</a> Cy_RTC_SetAlarmDateAndTime </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__rtc__alarm__t.html">cy_stc_rtc_alarm_t</a> const *&#160;</td>
          <td class="paramname"><em>alarmDateTime</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__rtc__enums.html#gad3785b5ad8bf1b0d49cc5f639176db5f">cy_en_rtc_alarm_t</a>&#160;</td>
          <td class="paramname"><em>alarmIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets alarm time and date values into the ALMx_TIME and ALMx_DATE registers. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">alarmDateTime</td><td>The alarm configuration structure, see <a class="el" href="structcy__stc__rtc__alarm__t.html">cy_stc_rtc_alarm_t</a>.</td></tr>
    <tr><td class="paramname">alarmIndex</td><td>The alarm index to be configured, see <a class="el" href="group__group__rtc__enums.html#gad3785b5ad8bf1b0d49cc5f639176db5f">cy_en_rtc_alarm_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A validation check result of date and month. Returns an error, if the date range is invalid. See <a class="el" href="group__group__rtc__enums.html#ga45a1b113f07f81bc369d7bf9da75eaae">cy_en_rtc_status_t</a>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The function may return CY_RTC_INVALID_STATE if the RTC is busy with previous update. In such situation, user should call this function repetitively with appropriate parameters to ensure that RTC is updated with provided arguments. </dd></dl>

</div>
</div>
<a id="ga5d29c0bfa51f4afd969d448d13f502bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d29c0bfa51f4afd969d448d13f502bd">&#9670;&nbsp;</a></span>Cy_RTC_GetAlarmDateAndTime()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_RTC_GetAlarmDateAndTime </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__rtc__alarm__t.html">cy_stc_rtc_alarm_t</a> *&#160;</td>
          <td class="paramname"><em>alarmDateTime</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__rtc__enums.html#gad3785b5ad8bf1b0d49cc5f639176db5f">cy_en_rtc_alarm_t</a>&#160;</td>
          <td class="paramname"><em>alarmIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the current alarm time and date values from the ALMx_TIME and ALMx_DATE registers. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">alarmDateTime</td><td>The alarm configuration structure, see <a class="el" href="structcy__stc__rtc__alarm__t.html">cy_stc_rtc_alarm_t</a>.</td></tr>
    <tr><td class="paramname">alarmIndex</td><td>The alarm index to be configured, see <a class="el" href="group__group__rtc__enums.html#gad3785b5ad8bf1b0d49cc5f639176db5f">cy_en_rtc_alarm_t</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga67d28741bf5b0bee6be7b2e4ce45ef77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga67d28741bf5b0bee6be7b2e4ce45ef77">&#9670;&nbsp;</a></span>Cy_RTC_SetAlarmDateAndTimeDirect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__rtc__enums.html#ga45a1b113f07f81bc369d7bf9da75eaae">cy_en_rtc_status_t</a> Cy_RTC_SetAlarmDateAndTimeDirect </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>sec</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>min</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>hour</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>date</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>month</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__rtc__enums.html#gad3785b5ad8bf1b0d49cc5f639176db5f">cy_en_rtc_alarm_t</a>&#160;</td>
          <td class="paramname"><em>alarmIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets alarm time and date values into the ALMx_TIME and ALMx_DATE registers using direct time parameters. </p>
<p>ALM_DAY_EN is default 0 (=ignore) for this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sec</td><td>The alarm second valid range is [0-59].</td></tr>
    <tr><td class="paramname">min</td><td>The alarm minute valid range is [0-59].</td></tr>
    <tr><td class="paramname">hour</td><td>The valid range is [0-23]. This parameter type is always in the 24-hour type. This function reads the current 12/24-hour mode, then converts the hour value properly as the mode.</td></tr>
    <tr><td class="paramname">date</td><td>The valid range is [1-31], if the month of February is selected as the Month parameter, then the valid range is [0-29].</td></tr>
    <tr><td class="paramname">month</td><td>The alarm month valid range is [1-12].</td></tr>
    <tr><td class="paramname">alarmIndex</td><td>The alarm index to be configured, see <a class="el" href="group__group__rtc__enums.html#gad3785b5ad8bf1b0d49cc5f639176db5f">cy_en_rtc_alarm_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A validation check result of date and month. Returns an error, if the date range is invalid. See <a class="el" href="group__group__rtc__enums.html#ga45a1b113f07f81bc369d7bf9da75eaae">cy_en_rtc_status_t</a>. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
